Skip to content

Show doc comments before type expansions in hover information #7774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

mediremi
Copy link
Contributor

Before After
image image

When generating hover information, we currently show in order:

  1. main type
  2. expanded types
  3. docstrings

A frequent issue I run into is that my expanded types hover information is long enough that the hover preview box must be scrolled to view docstrings.

In this PR, I've changed the order we present this information to:

  1. main type
  2. docstrings
  3. expanded types

@mediremi mediremi force-pushed the docstrings-before-type-expansions-2 branch from 1dbdc67 to 6a89573 Compare August 16, 2025 11:49
@mediremi mediremi marked this pull request as ready for review August 16, 2025 11:49
Copy link

pkg-pr-new bot commented Aug 16, 2025

Open in StackBlitz

rescript

npm i https://pkg.pr.new/rescript-lang/rescript@7774

@rescript/darwin-arm64

npm i https://pkg.pr.new/rescript-lang/rescript/@rescript/darwin-arm64@7774

@rescript/darwin-x64

npm i https://pkg.pr.new/rescript-lang/rescript/@rescript/darwin-x64@7774

@rescript/linux-arm64

npm i https://pkg.pr.new/rescript-lang/rescript/@rescript/linux-arm64@7774

@rescript/linux-x64

npm i https://pkg.pr.new/rescript-lang/rescript/@rescript/linux-x64@7774

@rescript/win32-x64

npm i https://pkg.pr.new/rescript-lang/rescript/@rescript/win32-x64@7774

commit: 6a89573

@mediremi mediremi changed the title Show docstrings before type expansions in hover information Show doc comments before type expansions in hover information Aug 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant